home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / program / inter52f.zip / INT2WHLP.ZIP / I2W-HINT.TXT < prev    next >
Text File  |  1996-10-05  |  13KB  |  302 lines
  1. This is a sort of a guide to using the INT2WHLP precompiler. INT2WHLP
  2. transfers Ralf Brown's Interrupt List to some RTF (Rich-Text Format) files
  3. which can be used as input for Microsoft's HC31 WINHELP file compiler.
  4.  
  5. This text gives also some hints on using the the results of the compilation.
  6.  
  7.  
  8. COMPILATION
  9.  
  10. The easy way to compile the list is this:
  11.  
  12. Change to the directory where you want your INTWIN.HLP file. There should
  13. be at least 16 Mb free space on the disk. It can be the directory with the
  14. Interrupt List files (which we will call the Source Directory), but it is
  15. better to use a separate directory not to mess up the Source Directory. A
  16. subdirectory under the Source Directory would be fine. Copy the following
  17. files to the directory:
  18.     INTWIN.BAT
  19.     INT2WHLP.EXE
  20.     INT2WHLP.CFG
  21.     SHORTKEY.RTF (if program option -l- is used)
  22.     SEL_TOPC.RTF
  23.     MISC_INF.RTF
  24.     I2W_HH.RTF
  25.     INTWIN.PH    (see section COMPRESSION)
  26.     INTERRUP.ICO (see section ICON)
  27.     BAG.INI
  28. It is handy also to have:
  29.     I2W-FILE.TXT
  30.     I2W-HINT.TXT (this file)
  31.     I2W-CFG.TXT
  32.     I2W-OPT.TXT
  33. in the directory. For a partial compilation of the List, FLT_METH.RTF is
  34. required (see paragraph FLT_METH.RTF in I2W-FILE.TXT).
  35.  
  36. Make sure that the following files are in the Source Directory:
  37.     INTERRUP.LST or INTERRUP.A, INTERRUP.B, ...
  38.     INTERRUP.1ST
  39.     CATEGORY.KEY
  40.     OVERVIEW.LST
  41.     INTERRUP.PRI
  42.     PORTS.LST
  43.     MEMORY.LST
  44.     CMOS.LST
  45.     GLOSSARY.LST
  46. where INTERRUP.LST is the concatenation of INTERRUP.A, INTERRUP.B, ... .
  47.  
  48. Make sure that HC31.EXE is somewhere on the DOS path.
  49.  
  50. Type
  51.     INTWIN
  52. at the DOS prompt to start the compilation. On a 486/33MHz computer it
  53. takes INT2WHLP 1 1/2 minut to precompile release 41 of the List, and it
  54. takes HC31 40 minutes to create the INTWIN.HLP file.
  55.  
  56. Parameters to INTWIN will be passed to INT2WHLP, thus a compilation with
  57. only the compressed interrupt index can be made with
  58.     INTWIN -2-
  59. This will reduce the size of the resulting help file from about 5 Mb to
  60. about 4.85 Mb (release 44).
  61.  
  62. The configuration file in release 49+ disables the long version of interrupt
  63. search keys, to reduce the number of keywords and enable keyword searching in
  64. WinHelp version 4.00 (coming with Windows 95), which has a limited keyword
  65. capacity. If you are using WinHelp 3.10 or 3.11, you can override the
  66. disabling with
  67.     INTWIN -L+
  68.  
  69.  
  70. PROBLEMS
  71.  
  72. It has happened that the Interrupt List was changed so INT2WHLP failed to
  73. find aliases for some context strings. If this happens, a new INT2WHLP.CFG
  74. file will be included in INTERnnZ.ZIP (see COMPRESSION). If other errors
  75. occur during the compilation of the List, the README file in INTERnnZ.ZIP
  76. will give hints about how to solve the problem.
  77.  
  78.  
  79. ERROR CODES
  80.  
  81. INT2WHLP returns errorlevel 240 - 245 if a fatal error occurs. It returns
  82. errorlevel 1 if one or more warnings are issued (inconsistent Interrupt
  83. List). The INTWIN batch file will let the user bail out (with ^C) if a
  84. warning errorlevel was returned from INT2WHLP's compilation of the List.
  85. It is recommended to terminate the batch file and fix the inconsistency in
  86. the Interrupt List, and compile again.
  87.  
  88.  
  89. CONFIGURATION
  90.  
  91. The INT2WHLP program lets you personalize your INTWIN.HLP file. If you use
  92. high resolution graphics on a large screen, then read the comments in the
  93. [CONFIG] section of the INT2WHLP.CFG file. For more details, see the files
  94. I2W-CFG.TXT and I2W-OPT.TXT.
  95.  
  96.  
  97. ICON
  98.  
  99. INT2WHLP will look for file INTERRUP.ICO in the following directories, and
  100. in this order:
  101.     The current directory (typically the user's own icon).
  102.     INT2WHLP's home directory.
  103.     The source directory (where INTERRUP.LST/INTERRUP.A ... resides)
  104.  
  105. If found, it will be included as an icon in the help file. It will then be
  106. shown in Windows 3.1 when INTWIN.HLP is minimized. It will not have any
  107. effect in Windows 95 (WinHelp v. 4.00.950). To use an interrup.ico icon to
  108. identify intwin.hlp, it must be defined as the icon in the shortcut to
  109. intwin.hlp.
  110.  
  111.  
  112. COMPRESSION
  113.  
  114. The HC31 program supports three levels of compression: high, medium, and
  115. none. Medium compressed and uncompressed files are about 15% and 100%
  116. longer than highly compressed files, respectively. HC31 can use an existing
  117. Phrases file (a .PH file with compression information), and it needs not to
  118. be exactly up-to-date. Compiling release 41 with a PH file from release 40
  119. gives a file about 4% longer than a compilation with an up-to-date PH file.
  120.  
  121. Compiling the compression information file is very resource consuming. For
  122. Interrupt List release 41 compiled with INT2WHLP v. 1.10:
  123.     631 kb < required DOS RAM < 730 kB
  124.     27 Mb < required free disk space < 50 Mb
  125. The compilation of the compression info took 20 minutes, and the rest of
  126. the compilation took 40 minutes on a 486/33MHx computer. Actually, when
  127. the computer gave up due to insufficient RAM when 631 kb were available,
  128. it had already created an INTWIN.PH file that was identical to the final
  129. file.
  130.  
  131. We will compile a Phrases file when a new list is released, and upload
  132. it to SimTel a day or two after the release of the List in file
  133. INTERnnZ.ZIP where nn is the List release number. See INTERRUP.1ST for
  134. SimTel mirror sites.
  135.  
  136.  
  137. HIGH RESOLUTION GRAPHICS
  138.  
  139. The default settings allow you to display the List on a normal 640x480 VGA
  140. screen without the need of horizontal scroll. If you use high resolution
  141. graphics on a large screen, you will want to define another size of the
  142. secondary window used to display the tables, see comments in the [CONFIG]
  143. section in file INT2WHLP.CFG.
  144.  
  145. If you use a high resolution graphics on a screen with small dimensions, you
  146. might want to use a larger font. The file package I2W-TEST.ZIP contains files
  147. that let you experiment with different fonts with very short INT2WHLP and
  148. HC31 compilation times. Unzip the package to a subdirectory under your
  149. INT2WHLP directory and read its README file.
  150.  
  151. Tools are availabe to edit the position and size of the table window in an
  152. already compiled INTWIN.HLP file, e.g. WH_wEdit in the package WH_EDxxx.ZIP
  153. (xxx >= 111) in SimTel directory simtelnet/win3/winhelp.
  154.  
  155.  
  156. LIMITATIONS
  157.  
  158. DOS graphics characters where 176 <= code <= 223 are not converted to correct
  159. Windows equivalents. Horizontal and vertical single and double framing
  160. characters are converted to "-" and "|", and other graphics characters are
  161. converted to "+".
  162.  
  163. INT2WHLP cannot handle more than 63 per line of other characters with code
  164. > 126.
  165.  
  166.  
  167. WINHELP VERSION 4.00 LIMITATIONS
  168.  
  169. Version 4.00 of Microsoft's WinHelp program (coming with Windows 95) has a
  170. limited search index capacity. If the limit is exceeded, the search index
  171. window is left blank. Ways to enable keyword searching in Windows 95:
  172.     Complain to Microsoft about the limitaiton.
  173.     Use program option -L- to disable long interrupt search keys.
  174.     Reduce the number of extra files included in the compilation, or
  175.     include them as type 1 files rather than type 2 files (ports.lst and
  176.     memory.lst).
  177.     Use version 3.10/3.11 of WinHelp.exe.
  178.  
  179.  
  180. INTWIN's TOPIC SEARCH FACILITIES
  181.  
  182. INTWIN facilitates seaching interrupt topics with many different keys, based
  183. on:
  184.     a. Elements in the interrupt header line.
  185.     b. Keys in the file CATEGORY.KEY for the appropriate interrupt
  186.        category.
  187.     c. Combinations of interrupt number and register contents.
  188.     d. Category letters.
  189.  
  190. For example,
  191.  
  192. --------D-215E01CH00-----------------------------
  193. INT 21 - DOS 3.1+ network - SET MACHINE NAME
  194.     AX = 5E01h
  195.     CH = 00h undefine name (make it invalid)
  196.  
  197. will be listed with the following search keys:
  198.  
  199.     DOS 3.1+ network            \      a
  200.     SET MACHINE NAME            /
  201.     DOS kernal                  \ 
  202.     kernal (DOS)                 >     b
  203.     operating systems (DOS)     /
  204.     INT 21 AX = 5E01 CH = 00 5) \
  205.     INT 21 AX = 5E01         5)  \
  206.     INT 21 AH = 5E           5)   \
  207.     INT 21          1)       5)    \
  208.     21 5E01 CH00                    \
  209.     21 5E01                          > c
  210.     21 5E           2)              /
  211.     21              1)             /
  212.     AX = 5E01                     /
  213.     AH = 5E         3)           /
  214.     CH = 00                     /
  215.     D!              4)                 d
  216.  
  217. 1) WINHELP lists only the first 400 search hits.
  218. 2) The short form of an interrupt using AL to specify a function has two
  219.    leading dashes in the function number, e.g. the short form of
  220.    INT 2D AL = 10 is 2D --10.
  221.    Two dashes can be appended to the short form of an interrupt using AH for
  222.    funtion number, to distinguish the string from the more general string
  223.    used also as keyword for interrupts with the same value in the high part
  224.    of the AX register, e.g. 10 00-- will give less search hits than 10 00.
  225. 3) Use AH = nn to search for functions called with nn in AH or in the high
  226.    byte of AX. Use AX = nn-- to search for functions called with nn in AH and
  227.    no specific value in AL.
  228. 4) Because WINHELP's search facility does not distinguish between letter case,
  229.    the search keys for capital letter categories are the letter followed by
  230.    an exclamation mark.
  231. 5) Program option -l- and configuration file key longKeys=0 disable the long
  232.    interrupt search key.
  233.  
  234. TABLE CROSS-REFERENCES
  235.  
  236. Tables are separate topics in help files compiled with version 1.08+ of
  237. INT2WHLP. When referenced from a "#nnnn" hotspot, the table pops up in a
  238. secondary window, thus the user can easily change between the source in
  239. the main help window and the referenced table in the secondary window.
  240. However, secondary windows are less flexible than the main window: topics
  241. are not recorded in the history list, you cannot browse between topics (<<
  242. and >> pushbuttons), and the topics cannot be copied or printed from the
  243. secondary window. Therefore all tables have a "Copy to Main" hotspot at the
  244. top.
  245.  
  246. The table topic titles include the interrupt number and subfunction where
  247. the table is defined, and there is a hotspot at the end of each table that
  248. pops up the appropriate interrupt in the main window.
  249.  
  250. There are two search keys for each table topic: "#nnnn" where nnnn is the
  251. four digit table number, and the table title as given in the Interrupt List
  252. ("Bitfields for ...", "Call ... with:", "Format of ...", "Values for ...").
  253.  
  254.  
  255. FULL TEXT SEARCH FACILITIES
  256.  
  257. WinHelp's search facility offers search for predefined words or phrases.
  258. Various utilities offer full text search in help files, i.e. search the help
  259. file for any word or phrase the user specifies. These utilities are normally
  260. implememted as one or more dynamic link library files (DLLs), and macros are
  261. inserted in the help file to invoke the text search.
  262.  
  263. Oxford Computer Consultants include a special version of their FTS utility
  264. in the Interrupt List. To use the facility, copy HINTSRCH.DLL from Oxford
  265. Computer Consultants' program package HINTSRCH.ZIP to your Windows SYSTEM
  266. directory. INT2WHLP's configuration file inserts the proper macros in
  267. INTWIN.HLP. One of these macros inserts a "Find Text" pushbutton on
  268. WinHelp's button bar. HINTSRCH.DLL works only with INTWIN, see material in
  269. Oxford Computer Consultant's package for information about their products.
  270.  
  271. Also Microsoft offers an FTS kit. Microsoft's kit uses an index file causing
  272. the search to be extremely fast. A disadvantage is that it takes long time to
  273. compile the index file, and it occupies much disk space (it is 70% longer
  274. than INTWIN.HLP, 8.8 Mb vs. 5.2 Mb for Interrupt List release 45). For the
  275. benefit of those who have access to Microsoft's FTS kit and want to use it,
  276. INT2WHLP's configuration file inserts bag.ini as baggage in INTWIN.HLP, this
  277. file is required by the kit. Utilities are available that can edit the macros
  278. section of INTWIN.HLP to include the macros for Microsoft's kit (WH_wEdit,
  279. see section HIGH RESOLUTION GRAPHICS). The baggage causes no harm if it is 
  280. unused, and it occupies only about 100 bytes.
  281.  
  282.  
  283. HELP WINDOW PUSHBUTTONS
  284.  
  285. The Help Window includes some extra shortcut pushbuttons.
  286.  
  287. "Print" sends the current topic to the currently selected printer. To select
  288. another printer, use "Print Select..." from the "File" menu.
  289.  
  290. "Copy" copies the current topic to the Cllipboard. To copy only part of the
  291. topic, use "Copy..." from the "Edit" menu.
  292.  
  293. "Exit" closes both the main window and an open secodary (table) window.
  294. Selecting "Close" from the control menu or pressing Alt F4 closes only the
  295. main window.
  296.  
  297. "Print" and "Exit" are equivalent to selecting "Print Topic" and "Exit" from
  298. the "File" menu.
  299.  
  300. "Find Text", see FULL TEXT SEARCH FACILITIES.
  301.  
  302.